Inscoper::ConnectionConfig¶

Base class for connection configuration. More...

#include <ConnectionConfig.h>

Inherited by Inscoper::AdvancedConnectionConfig, Inscoper::EthernetConnectionConfig, Inscoper::USBConnectionConfig

Public Functions¶

	Name
	ConnectionConfig() Constructor.
	ConnectionConfig(unsigned char tag) Constructor.
virtual	~ConnectionConfig() Default destructor.
virtual void	fromXML(Inscoper::XMLNode & connectionNode) =0 Provide connection information from the XML connection node.
virtual void	toXML(Inscoper::XMLNode & xmlParent) =0 Export connection information in an XML node attached to the parent XML node.
virtual Inscoper::EConnectionType	getType() =0 Return the type of the current connection.
unsigned short	getTag() const Get the tag of the current connection.
void	setTag(unsigned short tag) Set the tag of the current connection.

Detailed Description¶

class Inscoper::ConnectionConfig;

Base class for connection configuration.

Note: This class is non-copyable and non-movable.

This abstract class defines the interface for configuring different types of connections (e.g., USB, Ethernet) used by devices.

Public Functions Documentation¶

function ConnectionConfig¶

inline ConnectionConfig()

Constructor.

Initializes a new instance of ConnectionConfig with a default tag of 0.

function ConnectionConfig¶

inline explicit ConnectionConfig(
    unsigned char tag
)

Constructor.

Parameters:

tag : The tag of the current connection

Initializes a new instance of ConnectionConfig with the specified tag.

function ~ConnectionConfig¶

inline virtual ~ConnectionConfig()

Default destructor.

function fromXML¶

virtual void fromXML(
    Inscoper::XMLNode & connectionNode
) =0

Provide connection information from the XML connection node.

Parameters:

connectionNode : The XML connection node containing connection information

Exceptions:

InscoperException if an error occurred

Reimplemented by: Inscoper::AdvancedConnectionConfig::fromXML, Inscoper::EthernetConnectionConfig::fromXML, Inscoper::USBConnectionConfig::fromXML

Populates the connection configuration from the provided XML connection node.

function toXML¶

virtual void toXML(
    Inscoper::XMLNode & xmlParent
) =0

Export connection information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Reimplemented by: Inscoper::AdvancedConnectionConfig::toXML, Inscoper::EthernetConnectionConfig::toXML, Inscoper::USBConnectionConfig::toXML

Serializes the connection configuration to the specified parent XML node.

function getType¶

virtual Inscoper::EConnectionType getType() =0

Return the type of the current connection.

Return: The type of the current connection

Reimplemented by: Inscoper::AdvancedConnectionConfig::getType, Inscoper::EthernetConnectionConfig::getType, Inscoper::USBConnectionConfig::getType

Retrieves the specific type of connection configuration.

function getTag¶

inline unsigned short getTag() const

Get the tag of the current connection.

Return: The current connection tag

Retrieves the tag identifier associated with this connection.

function setTag¶

inline void setTag(
    unsigned short tag
)

Set the tag of the current connection.

Parameters:

tag : The current connection tag

Assigns a tag identifier to this connection.

Updated on 2026-04-02 at 10:55:35 +0200